Introduction to QA-CLI

The QA·CLI tool is the command line interface to Helix QAC. The tool is designed to be used for integrating Helix QAC with build servers, but can also be used on a desktop. It features a command line interface of the form:

qacli <subcommand> [options...]

where related features are grouped under a subcommand, not unlike most version control system interfaces1.

Features are grouped under the following subcommands, which can be viewed by issuing the qacli -h command:

admin	Manage Helix QAC, CMA projects and the installation.	qacli admin
analyze	Run analysis on existing projects.	qacli analyze
auth	Authenticate with a results server.	qacli auth
baseline	Manage baseline settings on a project.	qacli baseline
cma	Manage CMA solutions.	qacli cma
config	Configuration of system settings.	qacli config component-path qacli config cpu qacli config file qacli config language qacli config license-server qacli config udl
export	Export settings.	qacli export
help	Provide help information.	qacli help
import	Import settings.	qacli import
log	Configure log settings and location.	qacli log
pprops	Configure the Project Properties.	qacli pprops
project	Content and configuration of a Helix QAC project.	qacli project config-file qacli project create \| modify qacli project extensions qacli project files qacli project multi-config qacli project remove qacli project roots qacli project upgrade
report	Generate analysis reports.	qacli report
sync	Synchronize files in a project.	qacli sync
upload	Send results to external systems.	qacli upload
validate	Interact with the Validate server.	qacli validate build qacli validate cibuild qacli validate config qacli validate connect qacli validate project qacli validate projects
view	View analysis results.	qacli view

Verbose usage information on the options for each subcommand can be accessed by issuing the following command:

qacli <subcommand> --help

The shortcut for the above is qacli <subcommand> ‑h.

Version information for the installation can be found using ‑v or ‑‑version, for example:

qacli --version

There are two options that appear across many subcommands: "‑‑qaf‑project" (or "‑P") and "‑‑config" (or "‑K").

The first option is "‑‑qaf‑project" and its shortcut is "‑P". Its argument is the path to the directory of the Helix QAC project with which you wish to work. For all subcommands except "admin", this option defaults to the current working directory.

The second is "‑‑config" and its shortcut "‑K". This is used to select a configuration for projects with multiple configurations (refer to Projects with Multiple Configurations for further details).